GET FormTypes?assetTypeId={assetTypeId}&take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}
Retrieves form types for the given parameters. All parameters are optional.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
assetTypeId |
Id of the asset type |
globally unique identifier |
None. |
take |
Number of form types to retrieve. Default is all form types |
integer |
None. |
skip |
Number of form types to skip before retrieval |
integer |
Default value is 0 |
sort |
List of sorting rules to describe how to sort the form types before retrieval |
Collection of Sort |
None. |
Operator | string |
None. |
|
Field | string |
None. |
|
Value | string |
None. |
|
Logic | string |
None. |
|
Filters | Collection of Filter |
None. |
Body Parameters
None.
Response Information
Resource Description
On success, a list of form types.
Name | Description | Type | Additional information |
---|---|---|---|
Data | Collection of FormType |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": [ { "FormTypeId": "02f9a85d-71e0-4383-a95a-50c84e503065", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "8a4c791f-6c5f-4d0d-8780-93226294e705", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "b1515e00-efbe-41b8-a2ad-51ac0c6afc69", "CreateDate": "2024-05-04T07:05:59.5011159-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-04T07:05:59.5011159-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-05-04T07:05:59.5011159-07:00", "Fields": [ { "FormTypeFieldId": "ba0a6225-8375-4b41-9a40-4bcc015b5e2a", "Section": { "FormTypeSectionId": "8659cb61-746b-4681-a3e7-28c4fd5baa5b", "Name": "sample string 1", "Label": "sample string 2", "DisplayOrder": 1, "IsRepeatable": true, "VisibleExpression": "sample string 4", "SourceSystemId": "sample string 5" }, "Name": "sample string 1", "Label": "sample string 2", "Description": "sample string 3", "DataType": { "DataTypeId": "72bb5c5e-bcb5-47d5-a37c-85562e176b72", "Name": "sample string 1" }, "Unit": { "UnitId": "9ba80b34-c053-4c82-b6d3-5b9cbf2aa79d", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "89e104bb-99e0-452b-92ba-02b9137e3323", "CreateDate": "2024-05-04T07:05:59.5011159-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-04T07:05:59.5011159-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "ValueExpression": "sample string 5", "RequiredExpression": "sample string 6", "IsAttachment": true, "DefaultValueExpression": "sample string 8", "IsAccumulator": true, "IsMultiline": true, "IsRepeatable": true, "VisibleExpression": "sample string 12", "SourceSystemId": "sample string 13" }, { "FormTypeFieldId": "ba0a6225-8375-4b41-9a40-4bcc015b5e2a", "Section": { "FormTypeSectionId": "8659cb61-746b-4681-a3e7-28c4fd5baa5b", "Name": "sample string 1", "Label": "sample string 2", "DisplayOrder": 1, "IsRepeatable": true, "VisibleExpression": "sample string 4", "SourceSystemId": "sample string 5" }, "Name": "sample string 1", "Label": "sample string 2", "Description": "sample string 3", "DataType": { "DataTypeId": "72bb5c5e-bcb5-47d5-a37c-85562e176b72", "Name": "sample string 1" }, "Unit": { "UnitId": "9ba80b34-c053-4c82-b6d3-5b9cbf2aa79d", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "89e104bb-99e0-452b-92ba-02b9137e3323", "CreateDate": "2024-05-04T07:05:59.5011159-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-04T07:05:59.5011159-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "ValueExpression": "sample string 5", "RequiredExpression": "sample string 6", "IsAttachment": true, "DefaultValueExpression": "sample string 8", "IsAccumulator": true, "IsMultiline": true, "IsRepeatable": true, "VisibleExpression": "sample string 12", "SourceSystemId": "sample string 13" } ], "SourceSystemId": "sample string 3", "CompanyId": "2a68e5e4-29c4-4433-96ad-eec1d7511fdf", "CreateDate": "2024-05-04T07:05:59.5011159-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-04T07:05:59.5011159-07:00", "LastModifiedUser": "sample string 6" }, { "FormTypeId": "02f9a85d-71e0-4383-a95a-50c84e503065", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "8a4c791f-6c5f-4d0d-8780-93226294e705", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "b1515e00-efbe-41b8-a2ad-51ac0c6afc69", "CreateDate": "2024-05-04T07:05:59.5011159-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-04T07:05:59.5011159-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-05-04T07:05:59.5011159-07:00", "Fields": [ { "FormTypeFieldId": "ba0a6225-8375-4b41-9a40-4bcc015b5e2a", "Section": { "FormTypeSectionId": "8659cb61-746b-4681-a3e7-28c4fd5baa5b", "Name": "sample string 1", "Label": "sample string 2", "DisplayOrder": 1, "IsRepeatable": true, "VisibleExpression": "sample string 4", "SourceSystemId": "sample string 5" }, "Name": "sample string 1", "Label": "sample string 2", "Description": "sample string 3", "DataType": { "DataTypeId": "72bb5c5e-bcb5-47d5-a37c-85562e176b72", "Name": "sample string 1" }, "Unit": { "UnitId": "9ba80b34-c053-4c82-b6d3-5b9cbf2aa79d", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "89e104bb-99e0-452b-92ba-02b9137e3323", "CreateDate": "2024-05-04T07:05:59.5011159-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-04T07:05:59.5011159-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "ValueExpression": "sample string 5", "RequiredExpression": "sample string 6", "IsAttachment": true, "DefaultValueExpression": "sample string 8", "IsAccumulator": true, "IsMultiline": true, "IsRepeatable": true, "VisibleExpression": "sample string 12", "SourceSystemId": "sample string 13" }, { "FormTypeFieldId": "ba0a6225-8375-4b41-9a40-4bcc015b5e2a", "Section": { "FormTypeSectionId": "8659cb61-746b-4681-a3e7-28c4fd5baa5b", "Name": "sample string 1", "Label": "sample string 2", "DisplayOrder": 1, "IsRepeatable": true, "VisibleExpression": "sample string 4", "SourceSystemId": "sample string 5" }, "Name": "sample string 1", "Label": "sample string 2", "Description": "sample string 3", "DataType": { "DataTypeId": "72bb5c5e-bcb5-47d5-a37c-85562e176b72", "Name": "sample string 1" }, "Unit": { "UnitId": "9ba80b34-c053-4c82-b6d3-5b9cbf2aa79d", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "89e104bb-99e0-452b-92ba-02b9137e3323", "CreateDate": "2024-05-04T07:05:59.5011159-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-04T07:05:59.5011159-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "ValueExpression": "sample string 5", "RequiredExpression": "sample string 6", "IsAttachment": true, "DefaultValueExpression": "sample string 8", "IsAccumulator": true, "IsMultiline": true, "IsRepeatable": true, "VisibleExpression": "sample string 12", "SourceSystemId": "sample string 13" } ], "SourceSystemId": "sample string 3", "CompanyId": "2a68e5e4-29c4-4433-96ad-eec1d7511fdf", "CreateDate": "2024-05-04T07:05:59.5011159-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-04T07:05:59.5011159-07:00", "LastModifiedUser": "sample string 6" } ], "Total": 1, "Message": "sample string 1" }